Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

google_assistant: Deprecate Google Assistant add-on #3870

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

agners
Copy link
Member

@agners agners commented Dec 19, 2024

The Google Assistant SDK Python library is no longer developed. Currently it seems no longer possible to setup this add-on since the OAuth Out-of-Band flow has been deprecated.

Summary by CodeRabbit

  • Documentation

    • Added a deprecation notice in the README for the Google Assistant SDK add-on, indicating it is no longer developed and archived.
  • Configuration Changes

    • Updated the stage attribute from experimental to deprecated in the configuration file, reflecting the lack of active support for the Google Assistant SDK.

The Google Assistant SDK Python library is no longer developed.
Currently it seems no longer possible to setup this add-on since the
OAuth Out-of-Band flow has been deprecated.
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

📝 Walkthrough

Walkthrough

The pull request introduces deprecation notices for the Google Assistant SDK add-on in Home Assistant. The changes are focused on signaling the end of development and support for this integration, with updates made to both the README.md file and the configuration YAML file. The modifications clearly communicate that the Google Assistant SDK is no longer actively maintained, and new setups are not possible due to deprecated OAuth out-of-band (OOB) flow.

Changes

File Change Summary
google_assistant/README.md Added deprecation notice highlighting that the Google Assistant SDK is archived and no longer developed
google_assistant/config.yaml Updated stage attribute from experimental to deprecated

These changes formally mark the Google Assistant SDK integration as deprecated, providing clear guidance to users about its current status and limitations.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
google_assistant/README.md (1)

3-9: Improve the deprecation notice formatting and clarity

The deprecation notice effectively communicates the status, but could be enhanced with these changes:

  1. Add a comma after "Hence" for better readability
  2. Consider making the deprecation status more prominent by adding "DEPRECATED" to the document title
-# Home Assistant Add-on: Google Assistant SDK
+# Home Assistant Add-on: Google Assistant SDK (DEPRECATED)

 > [!CAUTION]
 > **Deprecation notice**
 > The [Google Assistant SDK for device][google-assistant-sdk] Python library
 > this add-on depends on is no longer developed and has been archived. The
 > OAuth out-of-band (OOB) flow used by the add-on has been deprecated as well.
-> Hence a new setup is currently no longer possible.
+> Hence, a new setup is currently no longer possible.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~8-~8: Possible missing comma found.
Context: ...e add-on has been deprecated as well. > Hence a new setup is currently no longer poss...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff01adb and 283c98d.

📒 Files selected for processing (2)
  • google_assistant/README.md (2 hunks)
  • google_assistant/config.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • google_assistant/config.yaml
🧰 Additional context used
📓 Path-based instructions (1)
google_assistant/README.md (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🪛 LanguageTool
google_assistant/README.md

[uncategorized] ~8-~8: Possible missing comma found.
Context: ...e add-on has been deprecated as well. > Hence a new setup is currently no longer poss...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)
google_assistant/README.md (1)

31-31: LGTM!

The link to the Google Assistant SDK repository is properly formatted and provides valuable reference to users.

@frenck frenck merged commit 91160e1 into master Dec 22, 2024
8 of 11 checks passed
@frenck frenck deleted the google-assistant-deprecation branch December 22, 2024 23:08
stefvanhooijdonk pushed a commit to stefvanhooijdonk/addons that referenced this pull request Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants